*: fix 404 links in the v6.5 documentation - #23899
Conversation
The mysql2 documentation is no longer kept in the documentation/en directory of the sidorares/node-mysql2 repository, so the linked URL returns 404. Point it to the current documentation site instead. Ref: pingcap#17075
In the master branch of pingcap/tidb, br/pkg/lightning has been moved to lightning, and br/pkg/restore/systable_restore.go has been moved to br/pkg/restore/snap_client, so the linked URLs return 404. Pin them to the release-6.5 branch, which keeps the original paths and matches the TiDB version that this documentation describes. Ref: pingcap#17075
A trailing brace was included in the URL of the AilinKid profile, and the zhangjinpeng1987 account has been renamed to zhangjinpeng87, so both links return 404. These links have already been corrected in the master branch by pingcap#17041. Ref: pingcap#17075
|
Hi @sary8. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (2)
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughDocumentation-only edits correct repository branches, replace source-tree links with published mysql2 documentation links, and fix two contributor handles in the TiDB 6.5.7 release notes. ChangesDocumentation Corrections
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Bug fix 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. A rabbit hops through links made bright Comment |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
All reviewed link updates are focused and no blocking issues were identified.
Review effort: Lite
Findings: None
What changed in this PR
Fixes stale and malformed links in the TiDB v6.5 documentation.
Changes:
- Updates node-mysql2 documentation links.
- Pins TiDB source links to
release-6.5. - Corrects contributor profile links and URL formatting.
| File | Description |
|---|---|
tidb-troubleshooting-map.md |
Pins the Lightning source link to v6.5 |
tidb-lightning/tidb-lightning-overview.md |
Pins the Lightning source link to v6.5 |
releases/release-6.5.7.md |
Corrects contributor profile links |
faq/backup-and-restore-faq.md |
Pins the restore source link to v6.5 |
develop/dev-guide-sample-application-nextjs.md |
Updates the node-mysql2 documentation link |
develop/dev-guide-sample-application-aws-lambda.md |
Updates the node-mysql2 documentation link |
br/br-snapshot-guide.md |
Pins the restore source link to v6.5 |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This change updates the node-mysql2 documentation links in the sample app guides to the current docs site. The affected guides include AWS Lambda, Next.js, and Node.js MySQL2 examples, ensuring the connection pool and prepared statement references point to the correct pages.
|
@coderabbitai[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
[LGTM Timeline notifier]Timeline:
|
Synced from: pingcap/docs#23899 Target PR: pingcap#21944 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
|
/ok-to-test |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lilin90 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
First-time contributors' checklist
What is changed, added or deleted? (Required)
This PR fixes the 404 links that are still left in the
release-6.5branch, as requested in #17075.#17041 fixed this kind of link in
masterand was cherry-picked only torelease-8.0andrelease-7.5, sorelease-6.5still carries them. I checked every external link that this PR touches: the old URLs return 404 and the new ones return 200.develop/dev-guide-sample-application-aws-lambda.mddevelop/dev-guide-sample-application-nextjs.mdhttps://github.com/sidorares/node-mysql2/tree/master/documentation/enhttps://sidorares.github.io/node-mysql2/docs/documentationtidb-lightning/tidb-lightning-overview.mdtidb-troubleshooting-map.mdhttps://github.com/pingcap/tidb/tree/master/br/pkg/lightninghttps://github.com/pingcap/tidb/tree/release-6.5/br/pkg/lightningbr/br-snapshot-guide.mdfaq/backup-and-restore-faq.mdhttps://github.com/pingcap/tidb/blob/master/br/pkg/restore/systable_restore.go#L31https://github.com/pingcap/tidb/blob/release-6.5/br/pkg/restore/systable_restore.go#L31releases/release-6.5.7.mdhttps://github.com/AilinKid}https://github.com/AilinKidreleases/release-6.5.7.mdhttps://github.com/zhangjinpeng1987https://github.com/zhangjinpeng87Three notes on the approach:
pingcap/tidbsource links are pinned torelease-6.5instead ofmaster. *: fix broken links #17041 pointed them tomaster, but inmasterthese paths have moved again (br/pkg/lightningtolightning, andbr/pkg/restore/systable_restore.gotobr/pkg/restore/snap_client). Both paths still exist in therelease-6.5branch ofpingcap/tidb,release-7.5already uses this version-pinned form, and it keeps the linked source consistent with the TiDB version that this documentation describes. Please let me know if you would rather follow themasterform used in *: fix broken links #17041.aliaseschange from *: fix broken links #17041 is not ported. Those aliases cover/tidb/dev/...URLs fordevelop/dev-guide-sample-application-java-jdbc.md. No document in this branch links to the old path, and the corresponding/tidb/v6.5/...URL never existed, so the aliases are not needed here.develop/dev-guide-sample-application-aws-lambda.mdanddevelop/dev-guide-sample-application-nextjs.mdstill link tohttps://ask.pingcap.com/andhttps://support.pingcap.com/, which no longer resolve. They appear in 74 and 79 files across this branch andmasterhas replaced the whole "Need help?" block, so fixing them here would be inconsistent and out of scope. I am happy to file a separate issue or PR for them. Note that this may make theLinks (Fail Fast)job report these two files.Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
The fix is version-specific because each branch has to point at its own
pingcap/tidbbranch, so no cherry-pick label is added. A separate PR coversrelease-7.1.What is the related PR or file link(s)?
master)AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit